Night Owl 6

home *** CD-ROM | disk | FTP | other *** search

/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / fdla101.zip / FDLA.DOC < prev next >

Wrap

Text File | 1992-01-15 | 24KB | 516 lines

FrontDoor Log Analyzer - FDLA Version 1.01 Copyright 1991 by R.J. (Bob) Ross - ALL RIGHTS RESERVED SysOp - RJ's Byteline BBS - FidoNet 1:134/75 15 January, 1992 Short Preamble -------------- FDLA is a filter program to extract information contained in the FrontDoor logfile generated by the FrontDoor program. It provides a summary of the incoming/outgoing calls, mail/file transfers, session costs undialable nodes and BBS caller activity over the period covered by the FrontDoor log file. FDLA needs a "all events processed log level except for remote system info and AKA's" to generate a log with sufficient detail. I believe this is an option in setting up FrontDoor using FDSETUP. I claim no credit for any portion of FrontDoor or QSort programs. All Advanced Engineering sarl and Joaquim H. Homrighausen products are trademarks or registered trademarks of Advanced Engineering sarl or Joaquim H. Homrighausen. QSort Text Sort program is copyright by Ben Baker. FDLA is free for use in a non commercial environment and may be copied and distributed freely and publicly for this purpose. I do request that you register your copy of FDLA though. This is primarily to feed my ego and satisfy my curiosity on where my programs are being used. I have a world map on my wall and stick map pins in at the geographical location of known users of my programs. Please see Register.txt included with this documentation. If you use FDLA I ask that you take a few moments to complete it and send it off to me. Commercial establishments who wish to use FDLA, please contact me. We can work something out. FDLA is distributed "as is" and is guaranteed to do nothing except take up space on your disk. I do hope that you will find it more useful though. It does run on my IBM clone machine and the IBM compatible machines that it has been beta tested on. Kick Start ---------- For a "kick start" just place FDLA.EXE in any convenient directory on your hard disk but preferably in the same directory that FrontDoor creates it's log file in. At the DOS prompt, type FDLA -H to display the help screen. Command Line Switches --------------------- FDLA [<-switch>] [LOG=logfilename] All switches are optional as is the log filename and may be given in any order. Parsing of switches -H, -LL and -SN, are in -SN, -H and -LL order and are exclusive for obvious reasons. If no command line arguments are given, FDLA defaults to creating FDLARpt.Txt and uses the FrontDoor log (FD.LOG) in the default directory. - 2 - Switches ------- No switch on the command line will produce FDLARpt.Txt providing that FDLA resides in the same directory as the FrontDoor log file and a log file exists in the name of FD.LOG. -D Will make a data file FDLARpt.Dat containing the data, plus some additional data, displayed in Part I of the output report (FDLARpt.Txt) file. FDLARpt.Dat is a comma delimited text file which may be useful for other applications. A record field description of FDLARpt.Dat file is outlined in Annex B to this document file. -EXN This is a very powerful cloaking feature which will allow you to exclude whole Zones, Networks, and/or Nodes etc from FDLARpt.Txt. Example: -EXN,Net:Node (ie -EXN,1:134) will exclude a whole Network. -EXN,1:,2: would exclude all Zone 1 and Zone 2 Network Nodes. -EXN,1:134/75 would exclude only Node 75 in Zone 1 Net 134. Note: -EXN parameters are delimited by a comma (,). A maximum of 10 parameters may be used. If this feature is used, FDLA will behave as though no log entry occurred for the stated -EXN parameter(s). -H A brief help screen which describes the switches used to determine the program options or behaviour. -KTF Will cause the temporary work files created by FDLA to be retained. Temporary files created are: FDLATmp.$$$ - created to hold data extracted from the log file file to produce Part I of the FDLA output report file to summarize mail transfers and incoming/outgoing calls. FDLATmp.$$S - Sorted output from FDLATmp.$$$ input. FDLATmpF.$$$ - created to hold data extracted from the log file to produce Part II of the FDLA output report file to itemize file transfers. FDLATmpF.$$S - Sorted output from FDLATmpF.$$$ input. FDLATmpC.$$$ - A picture image of Session Cost Part III portions of the output report minus the closing last line. FDLATmpU.$$$ - created to hold data extracted from the log file to produce Part IV - Undialable Nodes. FDLATmpU.$$S - Sorted output from FDLATmpU.$$$ -L List FDLARpt.Txt to the screen after it has been produced by FDLA. The list procedure supports PgUp, PgDn, left, right, up down arrow keys, Esc and X to exit. - 3 - -LL Will list that last created FDLARpt.Txt residing in FDLA's home directory if it exists. -NHA By default, FDLA will use high Ascii characters to draw the boxes for the FDLARpt.Txt file output report. Using the -NHA switch will make FDLA use only low Ascii characters (-+|) to draw borders and boxes for the report. -SN System Name. Allows you to modify the FDLA.EXE program to include your System Name. If this switch is selected you will be prompted to enter your System Name. Upon completion, FDLA will modify itself and exit to DOS. Subsequent runs that generate FDLARpt.Txt will then print your System Name at the top of the output report. NOTE: This option will not work if you compress FDLA.EXE using an execute file compressor (LZEXE, PKLITE, etc) prior to modifying the FDLA execute file to include your system name. If you do, I can almost guarantee that you will lock up your system if you try to run FDLA after compression. You should be able to use the -SN option to add your System Name and then compress the execute file though. -SUP A powerful cloaking feature that will allow you to suppress the display of selected file names in Part II of FDLARpt.Txt. Example -SUP,.LZH,.ZIP will suppress display of all files with an extension of LZH and ZIP. -SUP,Nodediff will suppress display of all files that match "NODEDIFF". Note: Filename parameters are delimited by a comma (,). A maximum of 10 parameters may be used. LOG= LOG=drive:\path\log filename. Allows FDLA to run using log file names other than FD.LOG in the default directory or to run on a drive or in a directory other than where the log file is maintained by FrontDoor. Pitfalls -------- Some resident virus detectors may complain about FDLA.EXE being modified when you use the -SN switch. Also see NOTE under -SN regarding compressing FDLA.EXE. I have one example of a cost record in a FD.LOG that exceeds 32767 which would indicate that a single sessionn long distance call would be $327.67. I have ignored such records where the cost exceeds $300.00 in Part III as I now assume that this is a bug in the FD.LOG output. FDLA Version 1.00 would crash when numbers exceeded 32,767 while running the cost algorithm. This and subsequent versions should work OK by ignoring these entries. Those who frequently make long distance calls in excess of $300.00 per session can send me equivalent cash and I'll provide a custom copy of FDLA to record the cost of these calls. :-) As mentioned earlier, FDLA creates some temporary work files. If you - 4 - As mentioned earlier, FDLA creates some temporary work files. If you run out of disk space while FDLA is executing, this is probably the reason why. The solution; more disk space or smaller log files. Unless you use the -KTF switch, the work files will be deleted from your disk when FDLA has completed it's final output report. The used disk space consumed by the temporary files will then be returned to your system. FDLA needs to go out to DOS to externally sort some of it's work files (FDLATmp?.$$$). The default sort program used is QSort by Ben Baker. If DOS fails to find QSORT an error is returned to FDLA and it then looks for the DOS SORT program on your path and re-starts the sort process. If neither program can be found, FDLA exists with a file not found error. I highly recommend the use QSORT because it's much faster than SORT, uses less memory and will sort a file of any size subject to disk space limitations. If the sort is unsuccessful then the FDLA will terminate with a DOS error level of 1. If the program ends with an Out of Data error and indicates that file FDLATmp.$$S is nul, chances are you either ran out of memory or disk space. If you use the regular DOS SORT utility on LARGE log files, your chances of FDLA failing are VERY GOOD. The best solution is to use QSort. Those who don't have QSort can save some IO activity by placing a copy of the DOS Sort program in the same directory as FDLA and renaming it to QSort. If you run FDLA from a batch file the program will exit with an error level of 0 on successful completion. An error level of 1 will be returned to DOS if FDLA fails for any reason. Conclusion ---------- I will endeavour respond to and correct any reported bugs. I do not personally use FrontDoor as a mailer for my BBS however FDLA has been beta tested at a few high traffic nodes in FidoNet 1:134 and appears to be quite stable. I can only respond if log file samples are sent to me at FidoNet 1:134/75 so that I may analyze any reported problems and make appropriate corrective action. If you send logfiles, please indicate what version of FrontDoor you are using as well. I've noticed a few suttle differences in log entries which, if unknown to me, could affect the output from FDLA. - 5 - Strings in FD.LOG that are very important to FDLA are: --- BUSY Calling Carrier lost CONNECT From Incoming call at Mail received Mail transfer completed NO CARRIER NO DIAL No response from remote system Rcvd Rejecting human caller RING Sent Session handshake failure Timeout waiting for hello packet To Unable to complete mail transfer Unable to initiate transfer Undialable node Unexpected password Using: Fido If you merge logfiles from other applications which contain any of the foregoing strings, the output of FDLA could be unpredictable as best. Unfortunately the FrontDoor log does not contain a unique identification entry in the logfile such as is the case with MAX, BINK, TICK, etc, so the strings cannot be isolated from other log entries. - 6 - Please realize that although, to a non commercial user, FDLA is freeware, it costs real out of pocket money to develop and distribute FDLA both by myself and the SysOps who are gracious enough to distribute FDLA over the FidoNet Software Distribution Network (SDN) and other networks. The output of FDLA is not cast in stone. I'm always open to suggestions to improve the report or this documentation. Some users may notice that FDLA looks a lot like BinkLA, the BinkleyTerm Log Analyzer. That's because I wrote BinkLA. I incorporated many of BinkLA's features in FDLA. The soon to be released BinkLA Version 2.00 will use the same data file output format as FDLA so other application programs will be able to use data output from either FDLA or BinkLA to generate statistics unique to a Network or individual SysOp. If someone comes up with creative applications that use FDLA or BinkLA data files, I'd appreciate receiving a copy. The source code for FDLA will not be released either to the public domain or with copyright retention. FDLA does contain some library calls from a commercial library which are proprietary. The latest version of FDLA (Beta or otherwise) will always be available at RJ's Byteline BBS, FidoNet 1:134/75, using magic file name FDLA or may be downloaded from File Area 1 without prior registration. My system presently uses a Courier HST DS V32b V42b modem for high speed V32 and HST connections. A sample output of FDLA FDLARpt.Txt file is included as Annex A to this document file. Field and record descriptions for the files created by FDLA are included as Annex B. Enjoy..... Yours truly, R.J. (Bob) Ross Annex A Sample output of FDLARpt.Txt. Please note portions of Part I and Part II have been removed to shorten the sample. FD.LOG FDLA Version 1.01 POSTMASTER FrontDoor Log Statistics for the period From Tue 03 Sep 91 0:21:50 to Thu 05 Sep 91 0:12:47 ┌──────────────────┬────────────────────────────────────┬──────────────────┐ │░░░░░░░░░░░░░░░░░░│ Part I - Message Transfers & Calls │░░░░░░░░░░░░░░░░░░│ ╞══════════════╤═══╧════════════════╤═══════════════════╧═════╤══════╤═════╡ │Zone:Net/Node │ Telephone Calls │ Message Bytes │ CPS │ Tran│ │ Number │ Out │ Connect │ In │ Outgoing │ Incoming │ Avg │ Min│ ╞══════════════╧═════╧═════════╧════╧════════════╧════════════╧══════╧═════╡ │1:134/0 27 21 6 103,948 69,161 739 3.9│ │1:134/1 5 10 7 22,669 221,734 1357 3.0│ │1:134/10 23 15 5 46,318 13,009 674 1.5│ │1:134/11 13 13 0 31,300 0 601 0.9│ │1:134/93 16 20 8 10,359 1,091 212 0.9│ │1:358/1 0 2 2 55,364 1,383 1351 0.7│ │1:381/61 1 1 0 0 1,342 671 0.0│ ├──────────────────────────────────────────────────────────────────────────┤ │ TOTALS 1219 865 157 4,635,721 474,697 341 249.8│ ╘══════════════════════════════════════════════════════════════════════════╛ ┌───────────────────┬──────────────────────────────────┬───────────────────┐ │░░░░░░░░░░░░░░░░░░░│ PART II - Network File Transfers │░░░░░░░░░░░░░░░░░░░│ ╞══════════════╤════╧═══════════════╤══════════════════╧══════╤══════╤═════╡ │Zone:Net/Node │ │ File Bytes │ CPS │ Tran│ │ Number │ File Names │ Outgoing │ Incoming │ Rate │ Min│ ╞══════════════╧════════════════════╧════════════╧════════════╧══════╧═════╡ │1:134/0 FNEWS835.LZH 0 22,722 1623 0.2│ │1:134/500 ECHO_INT.LST 19,586 0 233 1.4│ │1:134/93 00860002.REQ 0 13 0 0.0│ │1:134/93 00860002.REQ 0 13 0 0.0│ ├──────────────────────────────────────────────────────────────────────────┤ │ TOTALS 7 33,929 22,775 354 2.7│ ╘══════════════════════════════════════════════════════════════════════════╛ ┌───────────────────┬──────────────────────────────────┬───────────────────┐ │░░░░░░░░░░░░░░░░░░░│ PART III - Network Session Costs │░░░░░░░░░░░░░░░░░░░│ ╞══════════════╤════╧═══════════════╤══════════════════╧══════╤════════════╡ │Zone:Net/Node │ Logged At │ Session Time │ Cost │ │ Number │ Date │ Time │ Hrs │ Mins │ Secs │ │ ╞══════════════╧═════════╧══════════╧═════════╧══════╧════════╧════════════╡ │1:381/61 04 Sep 91 6:31:50 0 0 21 $ 0.42 │ ╘══════════════════════════════════════════════════════════════════════════╛ ┌───────────────────┬──────────────────────────────────┬───────────────────┐ │░░░░░░░░░░░░░░░░░░░│ PART IV - Undialable Nodes │░░░░░░░░░░░░░░░░░░░│ ╞═══════════════════╧══════════════════════════════════╧═══════════════════╡ │1:134/102 1:134/15 1:134/25 1:134/45│ │1:134/49 1:134/79 1:134/80 1:134/81│ ╘══════════════════════════════════════════════════════════════════════════╛ ┌──────────────────────────┬────────────────────┬──────────────────────────┐ │░░░░░░░░░░░░░░░░░░░░░░░░░░│ PART V - SUMMARY │░░░░░░░░░░░░░░░░░░░░░░░░░░│ ╞══════════════════════════╧════╤═══════════════╧══════════════════════════╡ │ BBS Callers at 9600 = 1 │ Message Bytes Transferred = 5,110,418│ │ 2400 = 17 │ File Bytes Transferred = 56,704│ │ 1200 = 0 │ TOTAL Bytes Transferred = 5,167,122│ │ Other = 0 ├──────────────────────────────────────────┤ │ │ Message Connect Time = 4.2│ │ TOTAL BBS Callers = 18 │ File Transfer Connect Time = 0.0│ │ │ TOTAL Connect Time (Hours) = 4.2│ │ Rejected BBS Calls = 5 │ TOTAL Network Session Costs = $ 0.42│ │ ├──────────────────────────────────────────┤ │ │ Unsuccessful Connect Attempts= 511│ └───────────────────────────────┴──────────────────────────────────────────┘ Annex B Record description for file FDLARpt.Dat Field Data Type Remarks ----------------------------------------------------------------------- ZoneNetNode STRING A fixed length string of 15 characters containing the Zone:Net/Node number. CallsOut INTEGER Positive numbers up to 32,767 which contains a count of the number of outgoing telephone calls. Connect INTEGER A count of the number of successful telephone connects which includes both outgoing and incoming connects. CallsIn INTEGER A count of the number of incoming telephone calls. MByteOut LONG Positive numbers up to 2,147,483,647 which contains the total number of message bytes transmitted to a ZoneNetNode. MByteIn LONG Total number of message bytes received from a ZoneNetNode. MTimeOut INTEGER Total transmission time (in seconds) to transmit the total bytes in MByteOut. MTimeIn INTEGER Total transmission time (in seconds) to receive the total bytes in MByteIn. MByteOutIn LONG MByteOut + MByteIn MTimeOutIn LONG MTimeOut + MTimeIn MAvgCPS INTEGER MByteOutIn \ MTimeOutIn MTimeMinute SINGLE precision floating point decimal. Total transfer time (MTimeOut + MTimeIn) / 60. - 2 - Record description for temporary work files FDLATmp.$$$ & FDLATmp.$$S Field Data Type Remarks ----------------------------------------------------------------------- ZoneNetNode STRING Fixed Length 15 characters contains Zone:Net/Node number. MCallsOut INTEGER Number of telephone calls out. Always 1 or 0. MConnect INTEGER Number of successful telephone connects. Always 1 or 0. MCallsIn INTEGER Number of telephone calls in. Always 1 or 0. MByteOut LONG Number of mail bytes transmitted during a mail session. MByteIn LONG Number of mail bytes received during a mail session. MTimeOut INTEGER Number of seconds to transmit MByteOut. MTimeIn INTEGER Number of seconds to receive MByteIn. - 3 - Record description for FDLATmpF.$$$ & FDLATmpF.$$S Field Data Type Remarks ----------------------------------------------------------------------- ZoneNetNode STRING Fixed length string of 15 characters containing the Zone:Net/Node number. FileNm STRING Fixed length string of 12 characters containing the outgoing/incoming DOS filename. FileByteOut LONG Size in bytes of transmitted file. FileByteIn LONG Size in bytes of received file. FileCPS INTEGER Transmission CPS of outgoing/incoming file. Record description for FDLATmpU.$$$ & FDLATmpU.$$S Field Data Type Remarks ----------------------------------------------------------------------- ZoneNetNode STRING Fixed length string of 15 characters containing the Zone:Net/Node number.